Account Management Biz Api

[TOC]

V4r1/billingAccount/{id} [PATCH]

This operation allows partial updates of a account entity.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://[localhost]:[port]/tmf-api/accountManagement/v4r1/{businessId}/billingAccount/{id}

URL PARAMS

Header

Body

Request

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Autopay Enable

{
    "defaultPaymentMethod": {
        "@referredType": "AutoPay",
        "id": "PM-a6I3K0000008znQUAQ"
    },
    "extendedCharacteristics": [
        {
            "name": "restrictOrder",
            "valueType": "Boolean",
            "value": false
        },
        {
            "name": "MSISDN",
            "value": "345687234"
        },
        {
            "name": "Channel",
            "value": "Digital"
        },
        {
            "value": "9",
            "name": "autopayConsentTextVersion"
        }
    ]
}

Autopay Disable

{
    "defaultPaymentMethod": {
        "@referredType": "Non-Autopay",
        "id": "PM-a6I3K0000008znQUAQ"
    },
    "extendedCharacteristics": [
        {
            "name": "restrictOrder",
            "valueType": "Boolean",
            "value": false
        },
        {
            "name": "MSISDN",
            "value": "345687234"
        },
        {
            "value": "Digital",
            "name": "Channel"
        },
        {
            "value": "9",
            "name": "autopayConsentTextVersion"
        }
    ]
}

Definitions

Each of the request parameters is detailed.

extendedCharacteristics Values

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - PATCH request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "status": 200,
    "description": "Autopay change request received"
}

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because is not properly formed or is invalid."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/billingAccount/{id}"
        }]
}

[ 429 ]

Too Many Requests - client has sent too many requests in a space of time (rate limiting). When a server is under attack or just receiving a very large number of requests from a single party, responding to each with a 429 status code will consume resources. Therefore, servers may drop connections or take other steps instead of responding with the 429 status code, when limiting resource usage.

{
  "errors" : [{
      "code" : 429,
       "message" : "APIKIT:TOO_MANY_REQUESTS",
      "description" : "The client sent too many requests and server is not able to serve them all at the moment"
    }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /billingAccount/id for Business Id: 12345 not implemented"
    }]
  }